zoom: Add missing documentation
authorCarlos Garnacho <carlosg@gnome.org>
Wed, 9 Apr 2014 16:28:49 +0000 (18:28 +0200)
committerCarlos Garnacho <carlosg@gnome.org>
Fri, 23 May 2014 17:54:27 +0000 (19:54 +0200)
gtk/gtkgesturezoom.c

index f242d6d4eb5a6eadd35166cc02bf52381ecc871e..648d0bbc8e84507e1feb06255216f2cbca2c4415 100644 (file)
  *
  * Author(s): Carlos Garnacho <carlosg@gnome.org>
  */
+
+/**
+ * SECTION:gtkgesturezoom
+ * @Short_description: Zoom gesture
+ * @Title: GtkGestureZoom
+ * @See_also: #GtkGestureRotate
+ *
+ * #GtkGestureZoom is a #GtkGesture implementation able to recognize
+ * pinch/zoom gestures, whenever the distance between both tracked
+ * sequences changes, the #GtkGestureZoom:scale-changed signal is
+ * emitted to report the scale factor.
+ */
+
 #include "config.h"
 #include <math.h>
 #include <gtk/gtkgesturezoom.h>
@@ -138,6 +151,11 @@ gtk_gesture_zoom_class_init (GtkGestureZoomClass *klass)
    * GtkGestureZoom::scale-changed:
    * @controller: the object on which the signal is emitted
    * @scale: Scale delta, taking the initial state as 1:1
+   *
+   * This signal is emitted whenever the distance between both tracked
+   * sequences changes.
+   *
+   * Since: 3.14
    */
   signals[SCALE_CHANGED] =
     g_signal_new ("scale-changed",